Get All Operator Connect Sync Tasks
Get All Operator Connect Sync Tasks retrieves the status of all tasks performed for a specific customer tenant.
URL
{{baseUrl}}/api/v2/task/ocsync
HTTP Method
GET
Responses
■ | 200 Success |
Parameter |
Type |
Description |
---|---|---|
Scheduler Name |
string |
|
Job |
string |
Job Id of the task. |
Trigger Name |
string |
|
nextFireTimeUtc |
string($date-time) |
|
triggerState |
string |
|
scheduledFireTimeUtc |
string ($date-time) | |
actualFireTimeUtc |
string ($date-time) | |
finishedTimeUtc |
string ($date-time) | |
recovering |
boolean | |
exceptionMessage": |
string | |
"wasSuccessful |
boolean |
|
"executionResult |
string |
|
Example Request
curl --location --request GET 'https://tokensandbox1.finebak.com/tenantui/api/v2/task/tsk_msjob_cd4d3164-7cbc-4fd3-8e6b-22ee4bb6695a' \
--header 'Accept: application/json'
Example Response
{
"id": "tsk_msjob_cd4d3164-7cbc-4fd3-8e6b-22ee4bb6695a",
"status": "CompletedSuccess",
"details": [
"{\"Id\":\"cd4d3164-7cbc-4fd3-8e6b-22ee4bb6695a\",\"TenantId\":\"d1382f6b-4846-45d7-9ac8-0349c1ed5ead\",\"Status\":\"Complete\",\"CreatedAt\":\"2022-09-14T11:09:27.2181663+00:00\",\"CreatedBy\":\"AppId: \\u00274ca20c21-925a-442b-a5ea-fa4a06f42de5\\u0027\",\"TelephoneNumbers\":[{\"TelephoneNumber\":\"\\u002B972542566119\",\"Status\":\"Success\",\"ErrorCode\":null,\"ErrorMessage\":null},{\"TelephoneNumber\":\"\\u002B972542566117\",\"Status\":\"Success\",\"ErrorCode\":null,\"ErrorMessage\":null},{\"TelephoneNumber\":\"\\u002B972542566118\",\"Status\":\"Success\",\"ErrorCode\":null,\"ErrorMessage\":null},{\"TelephoneNumber\":\"\\u002B972542566116\",\"Status\":\"Success\",\"ErrorCode\":null,\"ErrorMessage\":null},{\"TelephoneNumber\":\"\\u002B972542566120\",\"Status\":\"Success\",\"ErrorCode\":null,\"ErrorMessage\":null}],\"ErrorMessage\":null}"
],
"executionMessages": null,
"outputData": {}
}
■ | 404 Not found |
Parameter |
Type |
Description/Examples |
---|---|---|
errors |
string |
Text description of the error. |
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
title |
string |
Email title. For example "One or more validation errors occurred." |
status |
string |
HTML error code i.e. 400 |
detail |
string |
Additional error details. |
traceId |
|
Error trace Id. |
instance |
string |
Error instance. |
Cac Profile |
string |
Information related to configured CAC sessions. |
ProxySet |
string |
Information related to SBC Proxy Sets. |
OnlinePstnGateway |
string |
Information related to OnlinePSTN Gateway of the SBC device attached to Calling Profiles (see Get Online PSTN Gateway. |
■ | 500 Server Error |